Improve trigger descriptions#157643
Conversation
emontnemery
requested review from
a team,
arturpragacz,
bdraco,
jbouwh and
synesthesiam
as code owners
| @@ -112,44 +112,44 @@ | |||
| "title": "Assist satellite", | |||
| "triggers": { | |||
| "idle": { | |||
There was a problem hiding this comment.
The keys for assist_satellite are not consistent with other domains
| @@ -41,44 +41,44 @@ | |||
| "title": "Lawn mower", | |||
| "triggers": { | |||
| "docked": { | |||
There was a problem hiding this comment.
should we change this to "returned_to_dock", or is "docked" good enough?
There was a problem hiding this comment.
Docked is good.
You explained it too me, we do not enforce the temporary state "Returning to dock". So it's for both. IT's good 👍🏻
| "name": "When a lawn mower has docked" | ||
| "name": "Lawn mower returned to dock" | ||
| }, | ||
| "errored": { |
There was a problem hiding this comment.
should we change this to "encounted_error", or is "errored" good enough?
| @@ -113,44 +113,44 @@ | |||
| "title": "Vacuum", | |||
| "triggers": { | |||
| "docked": { | |||
There was a problem hiding this comment.
Same comment as for lawn mower
| "name": "When a vacuum cleaner has docked" | ||
| "name": "Vacuum returned to dock" | ||
| }, | ||
| "errored": { |
There was a problem hiding this comment.
Same comment as for lawn mower
| "triggers": { | ||
| "armed": { | ||
| "description": "Triggers when an alarm is armed.", | ||
| "description": "Triggers when one or several alarms are armed, regardless of the mode.", |
There was a problem hiding this comment.
I discussed this a bit with @jlpouffier.
He first suggested "Triggers when one or several alarms are armed, regardless of the mode.", then I suggested to drop the "get", and in the PR I changed to "are".
Edit: Changed back to "get"
There was a problem hiding this comment.
Why not replace 'several' with 'more' to simplify the wording?
There was a problem hiding this comment.
OK with several >>> more.
Not a strong push, i'm also perfectly fine with several for that particular PR.
We've been struggling with wording for so long that I'm more willing to push something out the finish line now :D
jbouwh
left a comment
jbouwh
left a comment
There was a problem hiding this comment.
LGTM,
Thanks @emontnemery 👍
emontnemery
added
the
second-opinion-wanted
|
I want @jlpouffier to review before this is merged |
|
I hid the bot review comments because I don't think they were helpful |
|
@MartinHjelmare there have been a lot of discussions about the wording. |
|
Grammar isn't really something to discuss. It's either correct or wrong. What to discuss is what tense to use for the description. |
|
OK, let's not discuss grammar here then. Closing for now. |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
|
I'm ok with @MartinHjelmare proposal
EDIT: on hold, discussing with Martin .. Not sure I fully understand the nuances OK, discussing with @MartinHjelmare ✅ It's actually I'm ok with that, i'll review now with that in mind |
|
@emontnemery I made lots of comments, but only the first one is actually something I'd like to see changed I made a proposal alighed with other triggers |
MartinHjelmare
removed
the
second-opinion-wanted
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Proposed change
Improve trigger descriptions as discussed with @jlpouffier
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: